[Closed Alpha] Search documents
[Closed Alpha] Search documents
[Closed Alpha] Search documents using a query string and return relevant results.
GET
/
admin
/
v0
/
search
{
"success": true,
"documents": {
"posts": [
{
"id": "w6sy87nsu78w",
"created_at": "2024-02-01 04:04:39.198523+00",
"title": "My Post",
"slug": "my-post",
"feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"read_time_minutes": 5,
"file_attachments_count": 1,
"reactions_count": 10,
"comments_count": 2,
"slack_message": {
"id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
"message_ts": 1737338258.891569,
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "Hello, world!",
"type": "text"
}
]
}
]
}
],
"markdown": "This is the message mrkdwn text.",
"permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
"parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
},
"cover_image_url": "https://example.com/my-image.png",
"author": {
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
},
"references": {
"mentioned_slack_users": [
{
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
}
],
"mentioned_slack_channels": [
{
"slack_channel": {
"id": "C088TB6CRL4",
"name": "general"
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
}
}
],
"custom_emojis": [
{
"alias": "<string>",
"name": "wow",
"url": "https://example.com/wow.png"
}
],
"urls": [
{
"order_seen": 0,
"is_embedded_media": false,
"is_image": true,
"is_video": false,
"url": "https://example.com/tacos.png"
}
]
}
}
],
"comments": [
{
"id": "3e8d8ad8-c25d-4194-a8ae-11c39eaef919",
"created_at": "2024-02-01 04:04:39.198523+00",
"feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"parent_post_id": "w6sy87nsu78w",
"author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"file_attachments_count": 1,
"reactions_count": 10,
"slack_message": {
"id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
"message_ts": 1737338258.891569,
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "Hello, world!",
"type": "text"
}
]
}
]
}
],
"markdown": "This is the message mrkdwn text.",
"permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
"parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
},
"parent_post": {
"id": "w6sy87nsu78w",
"created_at": "2024-02-01 04:04:39.198523+00",
"title": "My Post",
"slug": "my-post"
},
"author": {
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
},
"references": {
"mentioned_slack_users": [
{
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
}
],
"mentioned_slack_channels": [
{
"slack_channel": {
"id": "C088TB6CRL4",
"name": "general"
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
}
}
],
"custom_emojis": [
{
"alias": "<string>",
"name": "wow",
"url": "https://example.com/wow.png"
}
],
"urls": [
{
"order_seen": 0,
"is_embedded_media": false,
"is_image": true,
"is_video": false,
"url": "https://example.com/tacos.png"
}
]
}
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Search query string
Minimum length:
1Response
200
application/json
Returns search results
The estimated time to read the post in minutes
The Slack message timestamp
The Slack message content in mrkdwn format
The URL permalink to the Slack message
The ID of the top-most parent Slack message, if this is a threaded reply
A user profile
Available options:
The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead. The users tagged in the Slack blocks
A user profile
The URLs used in the Slack blocks
0-indexed order of the URL in the Slack blocks
Whether the URL is from media (e.g. image, video) embedded within the Slack blocks, instead of the raw URL appearing directly in text
Whether the URL refers to an image
Whether the URL refers to a video
The URL of the cover image for the post
The Slack message timestamp
The Slack message content in mrkdwn format
The URL permalink to the Slack message
The ID of the top-most parent Slack message, if this is a threaded reply
A user profile
Available options:
The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead. The users tagged in the Slack blocks
A user profile
The URLs used in the Slack blocks
0-indexed order of the URL in the Slack blocks
Whether the URL is from media (e.g. image, video) embedded within the Slack blocks, instead of the raw URL appearing directly in text
Whether the URL refers to an image
Whether the URL refers to a video
Was this page helpful?
{
"success": true,
"documents": {
"posts": [
{
"id": "w6sy87nsu78w",
"created_at": "2024-02-01 04:04:39.198523+00",
"title": "My Post",
"slug": "my-post",
"feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"read_time_minutes": 5,
"file_attachments_count": 1,
"reactions_count": 10,
"comments_count": 2,
"slack_message": {
"id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
"message_ts": 1737338258.891569,
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "Hello, world!",
"type": "text"
}
]
}
]
}
],
"markdown": "This is the message mrkdwn text.",
"permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
"parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
},
"cover_image_url": "https://example.com/my-image.png",
"author": {
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
},
"references": {
"mentioned_slack_users": [
{
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
}
],
"mentioned_slack_channels": [
{
"slack_channel": {
"id": "C088TB6CRL4",
"name": "general"
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
}
}
],
"custom_emojis": [
{
"alias": "<string>",
"name": "wow",
"url": "https://example.com/wow.png"
}
],
"urls": [
{
"order_seen": 0,
"is_embedded_media": false,
"is_image": true,
"is_video": false,
"url": "https://example.com/tacos.png"
}
]
}
}
],
"comments": [
{
"id": "3e8d8ad8-c25d-4194-a8ae-11c39eaef919",
"created_at": "2024-02-01 04:04:39.198523+00",
"feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"parent_post_id": "w6sy87nsu78w",
"author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"file_attachments_count": 1,
"reactions_count": 10,
"slack_message": {
"id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
"message_ts": 1737338258.891569,
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "Hello, world!",
"type": "text"
}
]
}
]
}
],
"markdown": "This is the message mrkdwn text.",
"permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
"parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
},
"parent_post": {
"id": "w6sy87nsu78w",
"created_at": "2024-02-01 04:04:39.198523+00",
"title": "My Post",
"slug": "my-post"
},
"author": {
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
},
"references": {
"mentioned_slack_users": [
{
"profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
"created_at": "2024-02-01 04:04:39.198523+00",
"preferred_name": "John D.",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"slack_user_id": "U088HCYD418",
"slack_is_admin": false,
"slack_is_bot": false,
"slack_first_name": "John",
"slack_last_name": "Doe",
"slack_image_72": "https://example.com/image72.png",
"slack_image_original": "https://example.com/image.png",
"slack_profile": {
"deprecated": true,
"warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
"id": "U088HCYD418",
"is_admin": false,
"is_bot": false,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"image_72": "https://example.com/image72.png",
"image_original": "https://example.com/image.png"
}
}
],
"mentioned_slack_channels": [
{
"slack_channel": {
"id": "C088TB6CRL4",
"name": "general"
},
"feed": {
"id": "91795199-9d00-47c7-bd6e-d4049bb63451",
"label": "My Feed",
"slug": "my-feed"
}
}
],
"custom_emojis": [
{
"alias": "<string>",
"name": "wow",
"url": "https://example.com/wow.png"
}
],
"urls": [
{
"order_seen": 0,
"is_embedded_media": false,
"is_image": true,
"is_video": false,
"url": "https://example.com/tacos.png"
}
]
}
}
]
}
}